##########################################################################
#
#  Copyright (c) 2021, Cinesite VFX Ltd. All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are
#  met:
#
#      * Redistributions of source code must retain the above
#        copyright notice, this list of conditions and the following
#        disclaimer.
#
#      * Redistributions in binary form must reproduce the above
#        copyright notice, this list of conditions and the following
#        disclaimer in the documentation and/or other materials provided with
#        the distribution.
#
#      * Neither the name of John Haddon nor the names of
#        any other contributors to this software may be used to endorse or
#        promote products derived from this software without specific prior
#        written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
#  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
#  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
#  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
#  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
#  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
#  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
##########################################################################

import Gaffer
import GafferScene

Gaffer.Metadata.registerNode(

	GafferScene.FilterQuery,

	"description",
	"""
	Queries a filter for a particular location in a scene
	and outputs the results.
	""",

	# Work around StandardNodeGadget layout bug that would
	# place the `filter` nodule inside the frame.
	"nodeGadget:minWidth", 12.0,

	plugs = {

		"scene" : {

			"description" :
			"""
			The scene to query the filter for.
			""",

		},

		"filter" : {

			"description" :
			"""
			The filter to query.
			""",

			"plugValueWidget:type" : "GafferUI.ConnectionPlugValueWidget",
			"noduleLayout:section" : "right",

		},

		"location" : {

			"description" :
			"""
			The location within the scene to query the filter at.

			> Note : If the location does not exist then the query will not be
			> performed and all outputs will be set to their default values.
			""",

			"plugValueWidget:type" : "GafferSceneUI.ScenePathPlugValueWidget",
			"scenePathPlugValueWidget:scene" : "scene",
			"nodule:type" : "",

		},

		"exactMatch" : {

			"description" :
			"""
			Outputs `True` if the filter matches the location, and `False` otherwise.
			""",

			"layout:section" : "Settings.Outputs"

		},

		"descendantMatch" : {

			"description" :
			"""
			Outputs `True` if the filter matches a descendant of the location,
			and `False` otherwise.
			""",

			"layout:section" : "Settings.Outputs"

		},

		"ancestorMatch" : {

			"description" :
			"""
			Outputs `True` if the filter matches an ancestor of the location,
			and `False` otherwise.
			""",

			"layout:section" : "Settings.Outputs"

		},

		"closestAncestor" : {

			"description" :
			"""
			Outputs the location of the first ancestor matched by the filter.
			In the case of an exact match, this will be the location itself.
			""",

			"layout:section" : "Settings.Outputs"

		},

	}

)
